home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 24 / AACD 24.iso / AACD / Online / Epic4 / share / epic / help / 2_queries / list < prev    next >
Text File  |  2001-03-21  |  3KB  |  70 lines
  1. Synopsis:
  2.    list [<switch> [<arg>] [<switch> [<arg>] ...]] [<channel>]
  3.  
  4. Description:
  5.    This is used to list the channels that currently exist (i.e. that have
  6.    one or more client on them) on the network.  The output will include
  7.    the channel name (usually; see below), the number of users on that
  8.    channel, and the channel's current topic.
  9.  
  10.    If an exact channel name is given, only information about that channel
  11.    is returned.  If a '*' is used as the channel name, the current
  12.    channel is used.  Otherwise, the client will request the entire list
  13.    of channels.
  14.  
  15.    The client can search for specific channels or channels with certain
  16.    characteristics.  If a glob pattern is given for the channel name, all
  17.    channels matching that pattern are shown.  The list can be limited to
  18.    channels with only a certain number of users, those with a topic set,
  19.    or those that are private or public.  Multiple switches may be used at
  20.    once.
  21.  
  22.    LIST output is affected by channel modes.  If a channel has mode +p,
  23.    then its name will be masked in the list output.  However, it can
  24.    still be displayed normally if the exact channel name is known.  If
  25.    the channel has mode +s, then it will not appear in any LIST output,
  26.    whether the exact name is known or not.  These limitations only apply
  27.    to users not on the channels in question (i.e. a user on a +s channel
  28.    can list that channel normally).
  29.  
  30. Options:
  31.    -min <n>   shows channels with no less than n users
  32.    -max <n>   shows channels with no more than n users
  33.    -public    shows public channels only
  34.    -private   shows private channels only
  35.    -topic     shows channels with a topic set
  36.    -all       overrides any previous -public or -private switch
  37.    -wide      shows name and size using as little space as possible:
  38.        -name     sort list by channel name
  39.        -users    sort list by number of users per channel
  40.                 
  41. Examples:
  42.    To show channels with 3 to 15 users:
  43.       /list -min 3 -max 15
  44.  
  45.    To show public channels with "help" in the name:
  46.       /list -public #*help*
  47.  
  48.    To get a concise listing of channels with over 30 users, sorted by name:
  49.       /list -min 30 -wide -name
  50.  
  51.    To see how Undernet's LIST works (and see below):
  52.       /quote list help
  53.  
  54. See Also:
  55.    on(5) list, widelist
  56.  
  57. Other Notes:
  58.    Unless a specific channel name is given, the client will request the
  59.    entire channel list and filter it locally.  This is noteworthy because
  60.    large networks can easily have upwards of 2,000 channels at any given
  61.    moment.  Parsing such a large list will greatly slow the client.
  62.  
  63.    This can be circumvented on the Undernet, and networks that use recent
  64.    Undernet server code.  The protocol LIST command (which is not the same
  65.    as the client's internal LIST command) on such servers has been
  66.    expanded to allow for server-side filtering.  EPIC does not natively
  67.    support this protocol enhancement, so the command "/quote list" must be
  68.    used.  Use "/quote list help" for the exact syntax.
  69.  
  70.